Public Class JsonCustomConstructor As AbstractJsonConstructor

Code Sample

• %REM
  Creates a custom constructor to call a Pet's New method, which takes two parameters - name and type, in that order.
  This code is found in deser-80 sample.
  %END REM
  Dim pet as Pet
  Dim helper as New JsonConversionHelper
  Dim petConstructor as New JsonCustomConstructor()
  Call petConstructor.withParam("name", "").withParam("type", "")
  Set pet = helper.withCustomConstructor(petConstructor)._
      toObject(source, "Pet", "deser-80")._
      fromJson(source)

Methods Detail

• createObject

  Public Function createObject(className As String, libName As String) As Variant
  Overridden function
  idx	Argument	Data Type	Attributes	Comments
  1	className	String		Class to create an instance of
  2	libName	String		Script file where the class is defined
  Code Sample
  %REM Creates an instance of className as defined in a script file called libName, and assigns it to mainHolder's contents property. The code is an abbreviated version of code in JsonConversionHelper.toObject(). %END REM Me.mainHolder.isObject = True Dim noArgsConstructor as New JsonNoArgsConstructor() Set Me.mainHolder.contents = noArgsConstructor.createObject(className, libName)

• withContext

  Public Function withContext(source As JsonObject, converters List As AbstractJsonConverter) As JsonCustomConstructor
  Passes a JSON object from which to extract parameter values
  idx	Argument	Data Type	Attributes	Comments
  1	source	JsonObject		JsonObject from which to extract parameters for constructor
  2	converters	AbstractJsonConverter	List	List of AbstractJsonConverters with which to convert the parameters
  Code Sample
  %REM If a constructor is defined for the JsonConversionHelper, it is used to create an instance of className as defined in a script file called libName, using as its context a JsonObject (source) and the current jsonConversionHelper's list of converters. The code is an abbreviated version of code in JsonConversionHelper.toObject(). %END REM If Not Me.constructor is Nothing Then SetMe. mainHolder.contents = Me.constructor.withContext(source, Me.converters).createObject(className, libName) End If

• withLiteralParam

  Public Function withLiteralParam(paramVal As Variant) As JsonCustomConstructor
  Fluent method to pass a literal value as a parameter for the constructor
  idx	Argument	Data Type	Attributes	Comments
  1	paramVal	Variant		Literal value to pass to the constructor as nth parameter
  Code Sample
  %REM Ensures that when extracting the gender element from a JSON object, the target class's setGender method is called with the literal value "M". This is found in the CustomSetterTest sample, a hard-coded test for validation purposes only. %END REM Dim helper as New JsonConversionHelper() Dim genderConverter as New JsonSetterConverter() Call genderConverter.forSetter(setGender).withLiteralParam("M") Call helper.withCustomConverter("gender", genderConverter)

• withParam

  Public Function withParam(labelName As String, defaultValue As Variant) As JsonCustomConstructor
  Fluent method to retrieve a parameter value for the constructor from the JSON object or a default value to use if the label is not in the JSON object.
  idx	Argument	Data Type	Attributes	Comments
  1	labelName	String		Label to find in the JSON object
  2	defaultValue	Variant		Default to use, if the label is not in the JSON
  Code Sample
  %REM The code below calls the Session class's New method passing two parameters, the JSON object's "id" and "title" elements, in that order. The code can be found in the deser-70.txt example. %END REM Dim sess as Session Dim helper as New JsonConversionHelper Dim sessionConstructor as New JsonCustomConstructor Dim json as String json = |{"id":"Ad01","title":"Domino HA"}| Call sessionConstructor.withParam("id", "").withTitle("title", "") Set sess = helper.withCustomConstructor(sessionConstructor).fromJsonString(json, "Session", "deser-70")

• cleanup

  Public Sub cleanup()
  Resets globals
  Code Sample
  See AbstractJsonConverter.cleanup()

• Delete

  Public Sub Delete()
  Destructor, erases converter list

• New

  Public Sub New()